|

TorqueScript Console Functions constitutes documentation for the console functions of Torque Game Engine.
It was taken directly out of The Game Programmer's Guide to Torque by Edward Maurina. It's an outstanding resource—a must for anyone wanting to get serious about programming in Torque.
This page, not taken from that book, is a Table of contents and a list of Functions By Name
|
Contents
|
Full Table of contents for the TorqueScript Console Functions.
- 1. OpenAL
- 1.1 alxGetChannelVolume( channelID )
- 1.2 alxGetListenerf( ALEnum )
- 1.3 alGetListener3f( ALEnum )
- 1.4 alGetListeneri( ALEnum )
- 1.5 alxGetSourcef( handle , ALEnum )
- 1.6 alxGetSourcei( handle , ALEnum )
- 1.7 alxGetSource3f( handle , ALEnum )
- 1.8 alxGetStreamDuration( handle )
- 1.9 alxGetStreamPosition( handle )
- 1.10 alGetString( ALEnum )
- 1.11 alxGetWaveLen( fileName )
- 1.12 alListener3f( ALEnum , x , y , z)
- 1.13 alxListenerf( AlEnum , value )
- 1.14 alxIsPlaying( handle )
- 1.15 alxPlay( handle )
- 1.16 alxPlay( profile )
- 1.17 alxPlay( profile , x , y , z )
- 1.18 alxSetChannelVolume( channelD , volume )
- 1.19 alxSourcef( handle , ALEnum , value )
- 1.20 alxSourcei( handle , ALEenum , value )
- 1.21 alxSource3f( handle , ALEnum , x , y , z )
- 1.22 alxStop( handle )
- 1.23 alxStopAll()
- 1.24 OpenALInitDriver()
- 1.25 OpenALShutdownDriver()
- 1.26 alxCreateSource()
- 1.30 OpenALRegisterExtensions()
- 2. Debugging
- 3. String Manipulation
- 3.1 String Manipulation
- 3.2 addBadWord( aBadWord )
- 3.3 containsBadWords( string )
- 3.4 string filterString( baseString [ , replacementChars ] )
- 3.5 strcmp( string1 , string2 )
- 3.6 stricmp( string1 , string2 )
- 3.7 strlwr( sourceString )
- 3.8 strupr( sourceString )
- 3.9 getField( sourceString , index )
- 3.10 getFieldCount( sourceString )
- 3.11 getFields( sourceString , index [ , endindex ] )
- 3.12 removeField( sourceString , index )
- 3.13 setField( sourceString , index , replace )
- 3.14 strlen( string
- 3.15 getRecord( sourceString , index )
- 3.16 getRecordCount( sourceString )
- 3.17 getRecords( sourceString , index [ , endindex ] )
- 3.18 removeRecord( sourceString , index )
- 3.19 setRecord( sourceString , index , replace )
- 3.20 strreplace( sourceString , from , to )
- 3.21 getSubStr( sourceString , start , count )
- 3.22 strchr( sourceString , char )
- 3.23 strpos( sourceString , searchString [ , offset ] )
- 3.24 strstr( sourceString , searchString )
- 3.25 stripChars( sourceString , chars )
- 3.26 stripColorCodes( stringtoStrip )
- 3.26 stripMLControlChars( sourceString )
- 3.27 stripTrailingSpaces( sourceString )
- 3.28 ltrim( sourceString )
- 3.29 rtrim( sourceString )
- 3.30 trim( sourceString )
- 3.31 nextToken( tokenList , tokenVar , delimeter )
- 3.32 firstWord( sourceString )
- 3.33 getWord( sourceString ,index )
- 3.34 getWordCount( sourceString )
- 3.35 getWords( sourceString ,index [,endindex])
- 3.36 removeWord( sourceString ,index)
- 3.37 restWords( sourceString )
- 3.38 setWord( sourceString ,index,replace)
- 4. Networking
- 4.1 addTaggedString( string )
- 4.2 buildTaggedString( format , <arg1, ...arg9> )
- 4.3 detag( tagID )
- 4.4 dumpNetStringTable()
- 4.5 getTag( taggedString )
- 4.6 getTaggedString( tag )
- 4.7 removeTaggedString( tag )
- 4.8 gotoWebPage( address )
- 4.9 setNetPort( port )
- 4.10 telnetSetParameters( port, consolePass, listenPass [ , remoteEcho ] )
- 4.11 commandToClient( client, func [ , arg1, ... , argn ] )
- 4.12 commandToServer( func [ , arg1, ... , argn ] )
- 4.13 allowConnections( enable )
- 4.14 cancelServerQuery()
- 4.15 getServerCount()
- 4.16 queryLANServers( port , flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags )
- 4.17 queryMasterServer( flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags )
- 4.18 querySingleServer( address [ , flags ] )
- 4.19 setServerInfo( index )
- 4.20 startHeartbeat()
- 4.21 stopHeartbeat()
- 4.22 stopServerQuery()
- 4.23 getMaxFrameAllocation()
- 5. Console
- 6. Device I/O
- 7. File I/O
- 8. Packages
- 9. Objects
- 10. Event Scheduling
- 11. Datablocks
- 12. Video / Texturing
- 12.1 addMaterialMapping( materialName, map0 [ , ... , map97 ])
- 12.2 clearTextureHolds()
- 12.3 dumpTextureStats()
- 12.4 flushTextureCache()
- 12.5 getDesktopResolution()
- 12.6 getDisplayDeviceList()
- 12.7 getResolutionList( devicename )
- 12.8 getVideoDriverInfo()
- 12.9 isDeviceFullScreenOnly( devicename )
- 12.10 isFullScreen()
- 12.11 nextResolution()
- 12.12 png2jpg( pngFilename [ , quality ] )
- 12.13 prevResolution()
- 12.14 screenShot( filename , format )
- 12.15 setDefaultFov( defaultFOV )
- 12.16 setDisplayDevice( deviceName [, width [ , height [, bpp [, fullScreen] ] ] ] )
- 12.17 setFov( FOV )
- 12.18 setOpenGLAnisotropy( 0.0 .. max.f )
- 12.19 setOpenGLInteriorMipReduction( reductionVal )
- 12.20 setOpenGLMipReduction( reductionVal )
- 12.21 setOpenGLSkyMipReduction( reductionVal )
- 12.22 setOpenGLTextureCompressionHint ( hint )
- 12.23 setRes( width , height , bpp )
- 12.24 setScreenMode( width , height , bpp , fullScreen )
- 12.25 setVerticalSync( enable )
- 12.26 switchBitDepth()
- 12.27 toggleFullScreen()
- 12.28 videoSetGammaCorrection( gamma )
- 13. Special
- 14. Resource Management
- 15. Scene
- 16. Containers and Raycasts
- 16.1 ContainerBoxEmpty( mask , location , xRadius [ , yRadius , zRadius ] )
- 16.2 containerFindFirst( mask , location, , xRadius , yRadius , zRadius )
- 16.3 containerFindNext()
- 16.4 ContainerRayCast ( startPos , endPos , mask [ , exempt ] )
- 16.5 ContainerSearchCurrDist()
- 16.6 ContainerSearchCurrRadiusDist()
- 16.7 ContainerSearchNext()
- 16.8 InitContainerRadiusSearch ( centerPos , radius , mask )
- 17. Editors
- 18. Build
- 19. Time
- 20. GUIs
- 21. Math
- 21.1 getBoxCenter( box )
- 21.2 getRandomSeed()
- 21.3 mAbs( val )
- 21.4 mAcos( val )
- 21.5 mAsin( val )
- 21.6 mAtan( val )
- 21.7 mathInit( extention )
- 21.8 matrixCreate( posVec , rotVec )
- 21.9 MatrixCreateFromEuler ( rotVec )
- 21.10 MatrixMulPoint( transform , point )
- 21.11 MatrixMultiply( transformA , transformB )
- 21.12 MatrixMulVector( transform , vector )
- 21.13 mCeil( val )
- 21.14 mCos( val )
- 21.15 mDegToRad( val )
- 21.16 mFloatLength( val , numDecimals )
- 21.17 mFloor( val )
- 21.18 mLog( val )
- 21.19 mPow( val , power )
- 21.20 mRadToDeg( val )
- 21.21 mSin( val )
- 21.22 mSolveCubic( a , b , c , d )
- 21.23 mSolveQuadratic( a , b , c )
- 21.24 mSolveQuartic(a,b,c,d,e)
- 21.25 mSqrt( val )
- 21.26 mTan( val )
- 21.27 setRandomSeed( startSeed )
- 21.28 VectorAdd( vecA , vecB )
- 21.29 VectorCross( vecA , vecB )
- 21.30 VectorDist( vecA , vecB )
- 21.31 VectorDot( vecA , vecB )
- 21.32 VectorLen( vec )
- 21.33 VectorNormalize( vec )
- 21.34 VectorOrthoBasis( vec )
- 21.35 VectorScale( vec , scale )
- 21.36 VectorSub( vecA , vecB )
|
Functions by Name
- A
- 6.1 activateDirectInput()
- 6.2 activateKeyboard()
- 8.1 activatePackage( packageName )
- 3.2 addBadWord( aBadWord )
- 12.1 addMaterialMapping( materialName, map0 [ , ... , map97 ])
- 4.1 addTaggedString( string )
- 1.3 alGetListener3f( ALEnum )
- 1.4 alGetListeneri( ALEnum )
- 1.10 alGetString( ALEnum )
- 1.12 alListener3f( ALEnum , x , y , z)
- 4.13 allowConnections( enable )
- 1.26 alxCreateSource()
- 1.1 alxGetChannelVolume( channelID )
- 1.2 alxGetListenerf( ALEnum )
- 1.7 alxGetSource3f( handle , ALEnum )
- 1.5 alxGetSourcef( handle , ALEnum )
- 1.6 alxGetSourcei( handle , ALEnum )
- 1.8 alxGetStreamDuration( handle )
- 1.9 alxGetStreamPosition( handle )
- 1.11 alxGetWaveLen( fileName )
- 1.14 alxIsPlaying( handle )
- 1.13 alxListenerf( AlEnum , value )
- 1.15 alxPlay( handle )
- 1.17 alxPlay( profile , x , y , z )
- 1.16 alxPlay( profile )
- 1.18 alxSetChannelVolume( channelD , volume )
- 1.21 alxSource3f( handle , ALEnum , x , y , z )
- 1.19 alxSourcef( handle , ALEnum , value )
- 1.20 alxSourcei( handle , ALEenum , value )
- 1.22 alxStop( handle )
- 1.23 alxStopAll()
- B
- C
- 13.1 calcExplosionCoverage( source, targetObject , coverageMask )
- 5.1 call( funcName [ , args ... ] )
- 10.1 cancel( eventID )
- 4.14 cancelServerQuery()
- 12.2 clearTextureHolds()
- 5.2 cls( )
- 5.3 collapseEscape( text )
- 4.11 commandToClient( client, func [ , arg1, ... , argn ] )
- 4.12 commandToServer( func [ , arg1, ... , argn ] )
- 5.4 compile( fileName )
- 16.1 ContainerBoxEmpty( mask , location , xRadius [ , yRadius , zRadius ] )
- 16.2 containerFindFirst( mask , location, , xRadius , yRadius , zRadius )
- 16.3 containerFindNext()
- 16.4 ContainerRayCast ( startPos , endPos , mask [ , exempt ] )
- 16.5 ContainerSearchCurrDist()
- 16.6 ContainerSearchCurrRadiusDist()
- 16.7 ContainerSearchNext()
- 3.3 containsBadWords( string )
- 20.1 createCanvas( WindowTitle )
- 20.2 createEffectCanvas( WindowTitle )
- D
- E
- F
- G
- 21.1 getBoxCenter( box )
- 18.1 getBuildString()
- 13.4 getClipboard()
- 18.2 getCompileTimeString()
- 13.2 getControlObjectAltitude()
- 13.3 getControlObjectSpeed()
- 12.5 getDesktopResolution()
- 12.6 getDisplayDeviceList()
- 10.2 getEventTimeLeft( eventID )
- 3.9 getField( sourceString , index )
- 3.10 getFieldCount( sourceString )
- 3.11 getFields( sourceString , index [ , endindex ] )
- 7.8 getFileCount ( pattern )
- 7.9 getFileCRC( filename )
- 6.10 getJoystickAxes( instance )
- 4.23 getMaxFrameAllocation()
- 13.5 getModPaths()
- 21.2 getRandomSeed()
- 19.1 getRealTime()
- 3.15 getRecord( sourceString , index )
- 3.16 getRecordCount( sourceString )
- 3.17 getRecords( sourceString , index [ , endindex ] )
- 12.7 getResolutionList( devicename )
- 10.3 getScheduleDuration ( eventID )
- 4.15 getServerCount()
- 19.2 getSimTime()
- 3.21 getSubStr( sourceString , start , count )
- 4.5 getTag( taggedString )
- 4.6 getTaggedString( tag )
- 13.6 getTerrainHeight( position )
- 10.4 getTimeSinceStart( eventID )
- 18.3 getVersionNumber()
- 18.4 getVersionString()
- 12.8 getVideoDriverInfo()
- 3.33 getWord( sourceString ,index )
- 3.34 getWordCount( sourceString )
- 3.35 getWords( sourceString ,index [,endindex])
- 2.11 GLEnableLogging( enable )
- 2.12 GLEnableMetrics( enable )
- 4.8 gotoWebPage( address )
- I
- L
- M
- 21.3 mAbs( val )
- 21.4 mAcos( val )
- 21.5 mAsin( val )
- 21.6 mAtan( val )
- 21.7 mathInit( extention )
- 21.8 matrixCreate( posVec , rotVec )
- 21.9 MatrixCreateFromEuler ( rotVec )
- 21.10 MatrixMulPoint( transform , point )
- 21.11 MatrixMultiply( transformA , transformB )
- 21.12 MatrixMulVector( transform , vector )
- 21.13 mCeil( val )
- 21.14 mCos( val )
- 21.15 mDegToRad( val )
- 2.13 metrics( metric )
- 21.16 mFloatLength( val , numDecimals )
- 21.17 mFloor( val )
- 21.18 mLog( val )
- 21.19 mPow( val , power )
- 21.20 mRadToDeg( val )
- 21.21 mSin( val )
- 21.22 mSolveCubic( a , b , c , d )
- 21.23 mSolveQuadratic( a , b , c )
- 21.24 mSolveQuartic(a,b,c,d,e)
- 21.25 mSqrt( val )
- 21.26 mTan( val )
- N
- O
- P
- Q
- 4.16 queryLANServers( port , flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags )
- 4.17 queryMasterServer( flags , gametype , missiontype , minplayers , maxplayers , maxbots , regionmask , maxping , mincpu , filterflags )
- 4.18 querySingleServer( address [ , flags ] )
- 5.13 quit()
- R
- S
- 10.6 schedule( t , objID or 0, functionName, arg0, ... , argN )
- 12.14 screenShot( filename , format )
- 13.10 setClipboard( string )
- 12.15 setDefaultFov( defaultFOV )
- 12.16 setDisplayDevice( deviceName [, width [ , height [, bpp [, fullScreen] ] ] ] )
- 2.5 setEchoFileLoads( enable )
- 3.13 setField( sourceString , index , replace )
- 12.17 setFov( FOV )
- 2.6 setInteriorRenderMode( mode )
- 2.7 setLogMode( mode )
- 13.9 setModPaths( path )
- 4.9 setNetPort( port )
- 12.18 setOpenGLAnisotropy( 0.0 .. max.f )
- 12.19 setOpenGLInteriorMipReduction( reductionVal )
- 12.20 setOpenGLMipReduction( reductionVal )
- 12.21 setOpenGLSkyMipReduction( reductionVal )
- 12.22 setOpenGLTextureCompressionHint ( hint )
- 21.27 setRandomSeed( startSeed )
- 3.19 setRecord( sourceString , index , replace )
- 12.23 setRes( width , height , bpp )
- 12.24 setScreenMode( width , height , bpp , fullScreen )
- 4.19 setServerInfo( index )
- 12.25 setVerticalSync( enable )
- 3.38 setWord( sourceString ,index,replace)
- 13.11 setZoomSpeed( delay )
- 17.1 snapToggle()
- 4.20 startHeartbeat()
- 4.21 stopHeartbeat()
- 4.22 stopServerQuery()
- 3.22 strchr( sourceString , char )
- 3.5 strcmp( string1 , string2 )
- 3.6 stricmp( string1 , string2 )
- 3.4 string filterString( baseString [ , replacementChars ] )
- 3.25 stripChars( sourceString , chars )
- 3.26 stripColorCodes( stringtoStrip )
- 3.26 stripMLControlChars( sourceString )
- 3.27 stripTrailingSpaces( sourceString )
- 3.14 strlen( string
- 3.7 strlwr( sourceString )
- 3.23 strpos( sourceString , searchString [ , offset ] )
- 3.20 strreplace( sourceString , from , to )
- 3.24 strstr( sourceString , searchString )
- 9.3 strToPlayerName( playerName );
- 3.8 strupr( sourceString )
- 12.26 switchBitDepth()
- T
- V
- W
|
|